home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Controls / Visual Basic Controls.iso / vbcontrol / lbkocx11 / readme.txt < prev    next >
Encoding:
Text File  |  1997-11-18  |  13.6 KB  |  377 lines
  1.                  =======================
  2.                    LOGBOOK README.TXT
  3.                  OCX Version Release 1.1
  4.                  =======================
  5.  
  6.  
  7. Abstract
  8. --------
  9.  
  10. This package contains the Logbook ActiveX control.
  11.  
  12. This control implements a scrolling message console with very flexible file
  13. logging and time stamping capabilities. It comes as an ActiveX control (OCX)
  14. in both 16-bit and 32-bit versions. An earlier version (1.0) is still
  15. available as a VBX for use in Visual Basic 3.
  16.  
  17. The most relevant features of this object are:
  18.  
  19. - Clients write messages to the object, which time stamps and formats them.
  20.   The messages are then shown in a configurable scrolling window and
  21.   optionally logged to a file.
  22.  
  23. - Messages can have a "severity" attribute (e.g. 'debug', 'info', 'alert').
  24.   The object can filter messages whose severity is below a certain level.
  25.  
  26. - The control can track time in several ways, such as: 'current time',
  27.   'time since log started' and 'time since last message'. A user-defined
  28.   time stamp format can also be specified.
  29.  
  30. - A path (directory) for the log file location and an explicit file name can
  31.   be specified. Optionally, the object will automatically name the files by
  32.   encoding the time of creation.
  33.  
  34. - Logging can be started, stopped, paused and resumed. Event procedures are
  35.   available for  log-a-message and status change (i.e. start, stop, pause,
  36.   error) events.
  37.  
  38. - The control can open the log file automatically and close it after a
  39.   time-out has occurred or a certain number of messages has been logged.
  40.  
  41. - The control keeps statistics of the number of messages that were logged,
  42.   ignored and lost (i.e. sent when logging was off or paused). These
  43.   counters can be dumped to the log itself, or queried as separate read-only
  44.   properties.
  45.  
  46. - Finally, the control supports DDE conversations. It can receive messages
  47.   to be logged via DDE and/or echo the logged messages to DDE clients.
  48.  
  49. More complete documentation is contained in the help file you will
  50. find in this archive (Logbook.hlp).
  51.  
  52.  
  53. Getting the files
  54. -----------------
  55.  
  56. You can always get the latest release of this software from the
  57. official Logbook home page on the Web:
  58.  
  59.   http://www.multimedia.it/andy/logbook/
  60.  
  61. You can also contact the author by E-mail at the following address:
  62.  
  63.   andy@multimedia.it
  64.  
  65.   
  66.  
  67. More Information
  68. ----------------
  69.  
  70. The Logbook custom control began its life as a spare time
  71. self-training project on custom controls and Windows programming.
  72. Day after day, feature after feature, the control became a nice
  73. piece of software, and it was really a shame to let it gather dust
  74. in a drawer.
  75.  
  76. This piece of software was never actually intended for commercial
  77. use. However, just in case, there is a license mechanism built in
  78. that should convince you to check with the author before you attempt
  79. to make money out of this software. Please read the following
  80. sections for details.
  81.  
  82. I sincerely hope that you have as much fun using this software
  83. as I had writing it.
  84.  
  85.  
  86. What's new in release 1.1
  87. -------------------------
  88.  
  89. * New Methods (Start, Stop, Pause, Resume) can be used instead of the
  90.   old-style Action property. 
  91. * There is a new preferred method: Log, for logging messages to the control,
  92.   as opposed to the old LogMessage property and AddItem method.
  93. * It is possible to show the property page dialog at run time using the 
  94.   Properties method.
  95. * Can show the severity level of a message as 1st field in the log file
  96.   (off by default for compatibiltiy with old log file format).
  97. * There are 4 flag properties for showing or turning off the different
  98.   fields of a message:  ShowLevel, ShowTime, ShowID, ShowMessage
  99. * It is now possible to specify a Separator string which is inserted between
  100.   the log fields. By default, a single space is used, but this can be set to
  101.   a TAB, a comma, or any other string for subsequent easy manipulation of
  102.   the log file.
  103. * There is now a LogToConsole property, for simmetry with LogToFile. Note:
  104.   changing LogToFile is only effective before Log is opened.
  105. * The FilePath property can now explicitely contain one DOS-style
  106.   environment variable, like %TEMP%, that is interpreted at run-time.
  107.   The full log file path used while logging can be retrieved from the
  108.   FileFullPath property.
  109. * An AutoStart property has been define that, when true, makes the control
  110.   start a log file on the first received message. You no longer have to
  111.   explicitely start the log.
  112. * The 3-char limit in the ClientID has been eliminated. Ids can now be as
  113.   long as you like. The default client ID is now "???".
  114. * When the control is used in a different host from Visual Basic, the
  115.   Format$() syntax for TimeFormat is not longer available. In this case the
  116.   control falls back to a C-language style syntax for the time stamps.
  117. * The control now has convenient property pages for all relevant options.
  118. * The control can now be shown with either a "flat" or a 3D look, according
  119.   to the setting of the Appearance property.
  120.  
  121.  
  122. Previous Release History
  123. ------------------------
  124.  
  125. * OCX Version 1.0
  126.   A preliminary port of the custom control as a 16-bit OLE control (OCX),
  127.   with equivalent functionality to the VBX version.
  128.  
  129. * VBX Version 1.0
  130.   Initial release
  131.  
  132.  
  133. Contents of the Archive
  134. -----------------------
  135.  
  136. The distribution archive should contain the following files:
  137.  
  138.   Directory Lbkocx11
  139.     README.TXT  - This file
  140.     LOGBOOK.HLP - Control help file
  141.     SETUP.EXE   - Program for automatic installation
  142.     LOGBOOK.INF - Installation script for SETUP.EXE
  143.  
  144.   Directory Lbkocx11\CONTROLS
  145.     Logbook controls, 16 and 32-bit versions,
  146.     Visual Basic programming support file.
  147.  
  148.   Directory Lbkocx11\VBTEST
  149.     Sample test program, for use with Visual Basic 4
  150.  
  151.  
  152. Installation
  153. ------------
  154.  
  155. Preliminary Notes:
  156.  
  157. The Logbook control is a custom control suitable for use with 
  158. versions of Visual Basic supporting OCXs (4.0 or better). The
  159. 16-bit version of the control (LOGBK16.OCX) will only work with
  160. Visual Basic 4.0/16-bit, while the 32-bit version (LOGBK32.OCX)
  161. should work with 32-bit versions of Visual Basic.
  162.  
  163. In order to keep the file size down, this archive does not contain
  164. the shared Microsoft DLL that are needed to run this control:
  165.  
  166.     MFC40.DLL, MSVCRT40.DLL    (32-bit version)
  167.     OC25.DLL        (16-bit version)
  168.  
  169. You probably already have these DLLs on your system, but just in
  170. case, they are available for download at:
  171.  
  172.       http://www.multimedia.it/andy/logbook/download
  173.  
  174. or from in most on-line software archives.
  175.  
  176. The Logbook controls contained in the distribution archive are
  177. fully functional. However, you will require a license file in
  178. order to get rid of the warning dialog both at programming time
  179. and in executables.
  180.  
  181. To automatically install the software under NT 4, Windows 95:
  182.  
  183. Double click on the SETUP.EXE program from the Windows Explorer.
  184. This will install the controls, help file and sample applications
  185. on your system.
  186.  
  187. Please check out the Manual Installation Procedure detailed below
  188. anyway. Point 4 explains how you can use Visual Basic to check
  189. that the controls are properly registered, while point 2 explains
  190. how to install the license file that you may receive separately. 
  191.  
  192. To uninstall the package use the Windows Control Panel, "software"
  193. applet. In the list you find on the Add/Remove Software page, double
  194. click the entry named "Logbook Control".
  195.  
  196.  
  197. To install the controls MANUALLY:
  198.  
  199. The distribution archive should include the following files:
  200.  
  201.  LOGBK32.OCX    the custom control file - 32-bit version
  202.  LOGBK16.OCX    the custom control file - 16-bit version
  203.  LOGBOOK.HLP    the help file
  204.  LOGBOOK.BAS    support file for program development
  205.  
  206. Additionally, when you register you shall receive the license file,
  207. LOGBOOK.LIC via E-mail.
  208.  
  209. 1.  move LOGBK16.OCX, LOGBK32.OCX and LOGBOOK.HLP in a directory
  210.     of your choice. Usually OCX custom controls are installed in the
  211.     \WINDOWS\SYSTEM directory, but this is not a strict requirement.
  212.  
  213.     In design mode, the control can be loaded from any directory,
  214.     and it will attempt to locate the help file in the directory
  215.     where the control was loaded from.
  216.  
  217.     In run-time mode (when used by a compiled program), the control
  218.     should be somewhere in the search path.
  219.  
  220. 2.  The license file should be placed in the \WINDOWS directory.
  221.     Of course, you should not  distribute the license file with
  222.     executable programs you write.
  223.  
  224. 3.  The LOGBOOK.BAS file is not strictly needed (the control constants
  225.     can be read and copied into the source code with Visual Basic
  226.     object browser), but can be placed in your project source directory
  227.  
  228. 4.  Before you load any of the example programs, make sure you
  229.     REGISTER the control with the system from Visual Basic. To do
  230.     this, load Visual Basic with a new, blank project. Then select
  231.     the TOOLS menu, CUSTOM CONTROLS, then click the BROWSE button.
  232.     Go to the directory where the OCX control is installed, then
  233.     select it into the project. Close the Controls window clicking
  234.     OK. At this point Visual Basic should have registered the
  235.     control and it should work with all existing programs.
  236.  
  237. 5.  For automatic conversion of Visual Basic programs from VBX
  238.     to the OCX version of the control, edit VB.INI (normally in
  239.     c:\WINDOWS); locate the section named [VBX Conversions16] and
  240.     add the following line:
  241.  
  242. Logbook.vbx={813AE543-40C5-11D0-B4D8-444553540000}#1.0#0;C:\Windows\System\logbk16.ocx
  243.  
  244.     You can do the same for the 32-bit version of the control.
  245.     The VB.INI section to edit is [VBX Conversions32] and the
  246.     line to add is:
  247.  
  248. Logbook.vbx={813AE543-40C5-11D0-B4D8-444553540000}#1.0#0;C:\Windows\System\logbk32.ocx
  249.  
  250.  
  251. Copyright Notices
  252. -----------------
  253.  
  254. The Logbook Control is Copyright ⌐ 1995-1998 by Andy Zanna.
  255. All rights reserved.
  256.  
  257. Windows, Windows NT, Windows 95, Visual Basic, Excel, Access,
  258. Office, Visual Basic for Applications, VBScript, Windows
  259. Entertainment Packs, Visual C++, Front Page, ActiveX and
  260. Internet Explorer are either trademarks or registered trademarks
  261. of Microsoft Corporation.
  262.  
  263. Disclaimer
  264. ----------
  265.  
  266. THIS SOFTWARE AND THE ACCOMPANYING FILES ARE PROVIDED "AS IS" AND
  267. WITHOUT WARRANTIES AS TO PERFORMANCE OF MERCHANTABILITY OR ANY
  268. OTHER WARRANTIES WHETHER EXPRESSED OR IMPLIED. IN NO EVENT SHALL
  269. THE AUTHOR BE LIABLE FOR ANY DAMAGES, INCLUDING ANY LOSS OF PROFITS,
  270. LOSS OF DATA, INCLUDING BUT NOT LIMITED TO SPECIAL, INCIDENTAL,
  271. CONSEQUENTIAL, OR INDIRECT DAMAGES ARISING FROM THE USE OF THIS
  272. SOFTWARE.
  273.  
  274.  
  275. Distribution
  276. ------------
  277.  
  278. The distribution package for this version of the Logbook software
  279. must at least include the following files:
  280.  
  281.  LOGBK32.OCX
  282.  LOGBK16.OCX
  283.  LOGBOOK.HLP
  284.  LOGBOOK.BAS
  285.  README.TXT
  286.  
  287. This package can be freely distributed provided that:
  288.  
  289. 1.  It is not bundled with a commercial product.
  290.  
  291. 2.  All the files in the package are included and no changes of
  292.     any kind are made to the original files.
  293.  
  294. 3.  No charge or donation is requested for any copy of
  295.     the software itself, however made, except for the bare
  296.     cost of physical support, transmission medium and time
  297.     required to perform the copy.
  298.  
  299. In all other circumstances, written permission must be obtained
  300. from the author prior to distribution.
  301.  
  302. The custom control files (LOGBK16.OCX and LOGBK32.OCX) can be
  303. distributed alone only as part of a commercial product and only
  304. if the author of that product has a valid license for the Logbook
  305. software.
  306.  
  307. This license cannot be transferred to users or purchasers of the
  308. said commercial product.
  309.  
  310.  
  311. User License
  312. ------------
  313.  
  314. This package can be freely used for any legitimate personal,
  315. non-commercial purpose.
  316.  
  317. When used as component of a commercial  program, the producer
  318. is required to contact the Logbook author in order to obtain
  319. permission, in the form of a specific development license file
  320. (see Registration Information below).
  321.  
  322. The author reserves all right to change the distribution and
  323. licensing policy for any future major version of the Logbook
  324. software and derived products.
  325.  
  326. Source code for this package is not freely available. It can,
  327. however, be purchased from the author.
  328.  
  329.  
  330. About the Author
  331. ----------------
  332.  
  333. The author (Andy Zanna) is an electronic engineer with a broad
  334. experience in software design and production on a wide range of
  335. systems, from home computers to real-time systems, enterprise
  336. servers and large networks.
  337.  
  338. This software is in no way related to the authorÆs real work or
  339. to the company where he is employed.
  340.  
  341. Registrations, information queries and suggestions should be
  342. addressed to:
  343.  
  344.   Andy Zanna
  345.   Hauptstr. 41
  346.   D-71263
  347.   Merklingen - Weil der Stadt
  348.   Germany
  349.   
  350.   phone:    +49-7033-33800
  351.   E-mail:    zanna@multimedia.it
  352.  
  353.  
  354. Registration Information
  355. ------------------------
  356.  
  357. If you register this control, you will receive a license file that
  358. will get rid of the warning dialog that is displayed when the control
  359. is loaded at design or run-time. You will then be able to compile
  360. stand-alone applications and distribute them free of royalty.
  361.  
  362. You will also receive notifications of updates and a right to use
  363. all minor updates (e.g. 1.x) with the same license.
  364.  
  365. The registration fee is US$ 25 or equivalent in major currencies
  366. (DM, UK Pound, F Franks), should be sent by mail money order to
  367. the address above. You should add another 5$ if you require that
  368. the software and the license be sent to you via ordinary mail,
  369. rather than E-mail.
  370.  
  371. You should also send a registration notice by ordinary mail or
  372. E-mail (preferably) to the address above, indicating your name,
  373. company (if applicable), mail and E-mail addresses.
  374.  
  375.                      * end of file *
  376.  
  377.